winscard.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 - 2013, Precise Biometrics AB
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Precise Biometrics AB nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 *
 * $Date: 2015-02-03 13:22:25 +0100 (Tue, 03 Feb 2015) $ $Rev: 26843 $ 
 *
 */

#ifndef _WINSCARD_H_
#define _WINSCARD_H_

#include <errno.h>
#include "wintypes.h"

#pragma mark SCARD_SCOPE_

#define SCARD_SCOPE_USER                    0

#define SCARD_SCOPE_TERMINAL                1 

#define SCARD_SCOPE_SYSTEM                  2 

#pragma mark SCARD_SHARE_

#define SCARD_SHARE_EXCLUSIVE               1 

#define SCARD_SHARE_SHARED                  2 

#define SCARD_SHARE_DIRECT                  3 

#define SCARD_LEAVE_CARD                    0 

#define SCARD_RESET_CARD                    1 

#define SCARD_UNPOWER_CARD                  2 

#define SCARD_EJECT_CARD                    3 

#define SCARD_AUTOALLOCATE                  (DWORD)(-1) 

#define SCARD_UNKNOWN                       0 

#define SCARD_ABSENT                        1 

#define SCARD_PRESENT                       2 

#define SCARD_SWALLOWED                     3 

#define SCARD_POWERED                       4 

#define SCARD_NEGOTIABLE                    5 

#define SCARD_SPECIFIC                      6 

#define SCARD_STATE_UNAWARE                 0x00000000  

#define SCARD_STATE_IGNORE                  0x00000001  

#define SCARD_STATE_CHANGED                 0x00000002  

#define SCARD_STATE_UNKNOWN                 0x00000004  

#define SCARD_STATE_UNAVAILABLE             0x00000008  

#define SCARD_STATE_EMPTY                   0x00000010  

#define SCARD_STATE_PRESENT                 0x00000020  

#define SCARD_STATE_ATRMATCH                0x00000040  

#define SCARD_STATE_EXCLUSIVE               0x00000080  

#define SCARD_STATE_INUSE                   0x00000100  

#define SCARD_STATE_MUTE                    0x00000200  

#define SCARD_STATE_UNPOWERED               0x00000400  

#define SCARD_S_SUCCESS                     ((DWORD)0x00000000L)

#define SCARD_F_INTERNAL_ERROR              ((DWORD)0x80100001L)

#define SCARD_E_CANCELLED                   ((DWORD)0x80100002L)

#define SCARD_E_INVALID_HANDLE              ((DWORD)0x80100003L)

#define SCARD_E_INVALID_PARAMETER           ((DWORD)0x80100004L)

#define SCARD_E_INVALID_TARGET              ((DWORD)0x80100005L)

#define SCARD_E_NO_MEMORY                   ((DWORD)0x80100006L)

#define SCARD_F_WAITED_TOO_LONG             ((DWORD)0x80100007L)

#define SCARD_E_INSUFFICIENT_BUFFER         ((DWORD)0x80100008L)

#define SCARD_E_UNKNOWN_READER              ((DWORD)0x80100009L)

#define SCARD_E_TIMEOUT                     ((DWORD)0x8010000AL)

#define SCARD_E_SHARING_VIOLATION           ((DWORD)0x8010000BL)

#define SCARD_E_NO_SMARTCARD                ((DWORD)0x8010000CL)

#define SCARD_E_UNKNOWN_CARD                ((DWORD)0x8010000DL)

#define SCARD_E_CANT_DISPOSE                ((DWORD)0x8010000EL)

#define SCARD_E_PROTO_MISMATCH              ((DWORD)0x8010000FL)

#define SCARD_E_NOT_READY                   ((DWORD)0x80100010L)

#define SCARD_E_INVALID_VALUE               ((DWORD)0x80100011L)

#define SCARD_E_SYSTEM_CANCELLED            ((DWORD)0x80100012L)

#define SCARD_F_COMM_ERROR                  ((DWORD)0x80100013L)

#define SCARD_F_UNKNOWN_ERROR               ((DWORD)0x80100014L)

#define SCARD_E_INVALID_ATR                 ((DWORD)0x80100015L)

#define SCARD_E_NOT_TRANSACTED              ((DWORD)0x80100016L)

#define SCARD_E_READER_UNAVAILABLE          ((DWORD)0x80100017L)

#define SCARD_P_SHUTDOWN                    ((DWORD)0x80100018L)

#define SCARD_E_PCI_TOO_SMALL               ((DWORD)0x80100019L)

#define SCARD_E_READER_UNSUPPORTED          ((DWORD)0x8010001AL)

#define SCARD_E_DUPLICATE_READER            ((DWORD)0x8010001BL)

#define SCARD_E_CARD_UNSUPPORTED            ((DWORD)0x8010001CL)

#define SCARD_E_NO_SERVICE                  ((DWORD)0x8010001DL)

#define SCARD_E_SERVICE_STOPPED             ((DWORD)0x8010001EL)

#define SCARD_E_UNEXPECTED                  ((DWORD)0x8010001FL)

#define SCARD_E_ICC_INSTALLATION            ((DWORD)0x80100020L)

#define SCARD_E_ICC_CREATEORDER             ((DWORD)0x80100021L)

#define SCARD_E_UNSUPPORTED_FEATURE         ((DWORD)0x80100022L)

#define SCARD_E_DIR_NOT_FOUND               ((DWORD)0x80100023L)

#define SCARD_E_FILE_NOT_FOUND              ((DWORD)0x80100024L)

#define SCARD_E_NO_DIR                      ((DWORD)0x80100025L)

#define SCARD_E_NO_FILE                     ((DWORD)0x80100026L)

#define SCARD_E_NO_ACCESS                   ((DWORD)0x80100027L)

#define SCARD_E_WRITE_TOO_MANY              ((DWORD)0x80100028L)

#define SCARD_E_BAD_SEEK                    ((DWORD)0x80100029L)

#define SCARD_E_INVALID_CHV                 ((DWORD)0x8010002AL)

#define SCARD_E_UNKNOWN_RES_MNG             ((DWORD)0x8010002BL)

#define SCARD_E_NO_SUCH_CERTIFICATE         ((DWORD)0x8010002CL)

#define SCARD_E_CERTIFICATE_UNAVAILABLE     ((DWORD)0x8010002DL)

#define SCARD_E_NO_READERS_AVAILABLE        ((DWORD)0x8010002EL)

#define SCARD_E_COMM_DATA_LOST              ((DWORD)0x8010002FL)

#define SCARD_E_NO_KEY_CONTAINER            ((DWORD)0x80100030L)

#define SCARD_E_SERVER_TOO_BUSY             ((DWORD)0x80100031L)

#define SCARD_E_PIN_CACHE_EXPIRED           ((DWORD)0x80100032L)

#define SCARD_E_NO_PIN_CACHE                ((DWORD)0x80100033L)

#define SCARD_E_READ_ONLY_CARD              ((DWORD)0x80100034L)

#define SCARD_W_UNSUPPORTED_CARD            ((DWORD)0x80100065L)

#define SCARD_W_UNRESPONSIVE_CARD           ((DWORD)0x80100066L)

#define SCARD_W_UNPOWERED_CARD              ((DWORD)0x80100067L)

#define SCARD_W_RESET_CARD                  ((DWORD)0x80100068L)

#define SCARD_W_REMOVED_CARD                ((DWORD)0x80100069L)

#define SCARD_W_SECURITY_VIOLATION          ((DWORD)0x8010006AL)

#define SCARD_W_WRONG_CHV                   ((DWORD)0x8010006BL)

#define SCARD_W_CHV_BLOCKED                 ((DWORD)0x8010006CL)

#define SCARD_W_EOF                         ((DWORD)0x8010006DL)

#define SCARD_W_CANCELLED_BY_USER           ((DWORD)0x8010006EL)

#define SCARD_W_CARD_NOT_AUTHENTICATED      ((DWORD)0x8010006FL)

#define SCARD_W_CACHE_ITEM_NOT_FOUND        ((DWORD)0x80100070L)

#define SCARD_W_CACHE_ITEM_STALE            ((DWORD)0x80100071L)

#define SCARD_W_CACHE_ITEM_TOO_BIG          ((DWORD)0x80100072L)

#define SCARD_PROTOCOL_UNDEFINED            0x00000000  

#define SCARD_PROTOCOL_T0                   0x00000001  

#define SCARD_PROTOCOL_T1                   0x00000002  

#define SCARD_PROTOCOL_RAW                  0x00010000  

#define SCARD_PROTOCOL_Tx                   (SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1)

#define SCARD_PROTOCOL_ANY                  SCARD_PROTOCOL_Tx

extern uint8_t g_bgm_disable;
#define DISABLE_BACKGROUND_MANAGEMENT       (&g_bgm_disable)

#define SCARD_ATTR_VALUE(Class, Tag) ((((DWORD)(Class)) << 16) | ((DWORD)(Tag)))

#define SCARD_CLASS_VENDOR_INFO     1   // Vendor information definitions
#define SCARD_CLASS_COMMUNICATIONS  2   // Communication definitions
#define SCARD_CLASS_PROTOCOL        3   // Protocol definitions
#define SCARD_CLASS_POWER_MGMT      4   // Power Management definitions
#define SCARD_CLASS_SECURITY        5   // Security Assurance definitions
#define SCARD_CLASS_MECHANICAL      6   // Mechanical characteristic definitions
#define SCARD_CLASS_VENDOR_DEFINED  7   // Vendor specific definitions
#define SCARD_CLASS_IFD_PROTOCOL    8   // Interface Device Protocol options
#define SCARD_CLASS_ICC_STATE       9   // ICC State specific definitions
#define SCARD_CLASS_PERF       0x7FFE   // performace counters
#define SCARD_CLASS_SYSTEM     0x7FFF   // System-specific definitions

/* Attribute to set/get whether or not the library automatically handles 
   background execution.
   Valid values are 0 to disable and 1 to enable the feature. The size of the 
   value buffer must be set to sizeof(BYTE). */
#define SCARD_ATTR_AUTO_BACKGROUND_HANDLING SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xB100) 

/* Attribute to set/get whether an inserted card shall be automatically powered when inserted
   in the reader.
   Most desktop implementations of PCSC will automatically power on the smart when it is inserted
   in the smart card reader. This implementation however will not automatically power on the card
   with regards to battery life of the iOS device.
   This means that the SCARD_READERSTATE structure used in SCardGetStatusChange will be populated
   somewhat differently compared with a desktop implementation. For example, the ATR value in
   rgbAtr/cbAtr will be blank prior to calls to SCardConnect.
   It is possible to enabled automatic power on in order to mimic desktop PCSC behaviour using
   the proprietary SCARD_ATTR_AUTO_POWER_ON attribute together with a call to SCardSetAttrib.
   The default value is set to disabled. The set value is global and is valid until the last
   SCARDCONTEXT is released with a call to SCardReleaseContext.
   Valid values are 0 to disable and 1 to enable the feature. The size of the
   value buffer must be set to sizeof(BYTE). */
#define SCARD_ATTR_AUTO_POWER_ON SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xB101)


typedef LONG SCARDCONTEXT;
typedef SCARDCONTEXT *PSCARDCONTEXT;
typedef SCARDCONTEXT *LPSCARDCONTEXT;
typedef LONG SCARDHANDLE; 
typedef SCARDHANDLE *PSCARDHANDLE;
typedef SCARDHANDLE *LPSCARDHANDLE;

#define SCARD_HANDLE_INVALID    0

#ifdef __APPLE__
#pragma pack(1)
#endif

typedef struct
{
    const char *szReader;
    void *pvUserData;
    DWORD dwCurrentState;
    DWORD dwEventState;
    DWORD cbAtr;
    unsigned char rgbAtr[33]; 
}
SCARD_READERSTATE, *LPSCARD_READERSTATE;

typedef struct
{
    DWORD dwProtocol;   
    DWORD cbPciLength;  
}
SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;

#ifdef __APPLE__
#pragma pack()
#endif

typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
extern SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci, g_rgSCardRawPci;

#define SCARD_PCI_T0                (&g_rgSCardT0Pci) 

#define SCARD_PCI_T1                (&g_rgSCardT1Pci) 

#define SCARD_PCI_RAW               (&g_rgSCardRawPci) 

LONG SCardEstablishContext(DWORD dwScope,
                           LPCVOID pvReserved1,
                           LPCVOID pvReserved2,
                           LPSCARDCONTEXT phContext);

LONG SCardReleaseContext(SCARDCONTEXT hContext);

LONG SCardConnect(SCARDCONTEXT hContext,
                  LPCSTR szReader,
                  DWORD dwShareMode,
                  DWORD dwPreferredProtocols,
                  LPSCARDHANDLE phCard,
                  LPDWORD pdwActiveProtocol);

LONG SCardReconnect(SCARDHANDLE hCard,
                    DWORD dwShareMode,
                    DWORD dwPreferredProtocols,
                    DWORD dwInitialization,
                    LPDWORD pdwActiveProtocol);

LONG SCardDisconnect(SCARDHANDLE hCard,
                     DWORD dwDisposition);

LONG SCardStatus(SCARDHANDLE hCard,
                 LPSTR mszReaderName,
                 LPDWORD pcchReaderLen,
                 LPDWORD pdwState,
                 LPDWORD pdwProtocol,
                 LPBYTE pbAtr,
                 LPDWORD pcbAtrLen);

LONG SCardGetStatusChange(SCARDCONTEXT hContext,
                          DWORD dwTimeout,
                          LPSCARD_READERSTATE rgReaderStates,
                          DWORD cReaders);
LONG SCardTransmit(SCARDHANDLE hCard,
                   const SCARD_IO_REQUEST *pioSendPci,
                   LPCBYTE pbSendBuffer,
                   DWORD cbSendLength,
                   SCARD_IO_REQUEST *pioRecvPci,
                   LPBYTE pbRecvBuffer,
                   LPDWORD pcbRecvLength);

LONG SCardListReaders(SCARDCONTEXT hContext,
                      LPCSTR mszGroups,
                      LPSTR mszReaders,
                      LPDWORD pcchReaders);

LONG SCardFreeMemory(SCARDCONTEXT hContext,
                     LPCVOID pvMem);

LONG SCardCancel(SCARDCONTEXT hContext);

LONG SCardIsValidContext(SCARDCONTEXT hContext);

LONG SCardSetAttrib(
    SCARDHANDLE hCard,
    DWORD dwAttrId,
    LPCBYTE pbAttr,
    DWORD cbAttrLen);
    
LONG SCardGetAttrib(
    SCARDHANDLE hCard,
    DWORD dwAttrId,
    LPBYTE pbAttr,
    LPDWORD pcbAttrLen);


#pragma mark Currently not implemented 

LONG SCardListReaderGroups(SCARDCONTEXT hContext,
                           LPSTR mszGroups,
                           LPDWORD pcchGroups);

LONG SCardControl(SCARDHANDLE hCard,
                  DWORD dwControlCode,
                  LPCVOID pbSendBuffer,
                  DWORD cbSendLength,
                  LPVOID pbRecvBuffer,
                  DWORD cbRecvLength,
                  LPDWORD lpBytesReturned);
LONG SCardBeginTransaction(SCARDHANDLE hCard);
LONG SCardEndTransaction(SCARDHANDLE hCard,
                         DWORD dwDisposition);
#endif /* _WINSCARD_H_ */